home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / tcl / tcl67.lha / tcl6.7 / doc / Hash.3 < prev    next >
Text File  |  1993-01-31  |  9KB  |  212 lines
  1. '\"
  2. '\" Copyright 1989 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/tcl/man/RCS/Hash.3,v 1.5 93/01/31 15:35:35 ouster Exp $ SPRITE (Berkeley)
  11. '\" 
  12. .so man.macros
  13. .HS Tcl_Hash tcl
  14. .BS
  15. .SH NAME
  16. .na
  17. Tcl_InitHashTable, Tcl_DeleteHashTable, Tcl_CreateHashEntry, Tcl_DeleteHashEntry, Tcl_FindHashEntry, Tcl_GetHashValue, Tcl_SetHashValue, Tcl_GetHashKey, Tcl_FirstHashEntry, Tcl_NextHashEntry, Tcl_HashStats \- procedures to manage hash tables
  18. .SH SYNOPSIS
  19. .nf
  20. \fB#include <tclHash.h>\fR
  21. .sp
  22. \fBTcl_InitHashTable\fR(\fItablePtr, keyType\fR)
  23. .sp
  24. \fBTcl_DeleteHashTable\fR(\fItablePtr\fR)
  25. .sp
  26. Tcl_HashEntry *
  27. \fBTcl_CreateHashEntry\fR(\fItablePtr, key, newPtr\fR)
  28. .sp
  29. \fBTcl_DeleteHashEntry\fR(\fIentryPtr\fR)
  30. .sp
  31. Tcl_HashEntry *
  32. \fBTcl_FindHashEntry\fR(\fItablePtr, key\fR)
  33. .sp
  34. ClientData
  35. \fBTcl_GetHashValue\fR(\fIentryPtr\fR)
  36. .sp
  37. \fBTcl_SetHashValue\fR(\fIentryPtr, value\fR)
  38. .sp
  39. char *
  40. \fBTcl_GetHashKey\fR(\fItablePtr, entryPtr\fR)
  41. .sp
  42. Tcl_HashEntry *
  43. \fBTcl_FirstHashEntry\fR(\fItablePtr, searchPtr\fR)
  44. .sp
  45. Tcl_HashEntry *
  46. \fBTcl_NextHashEntry\fR(\fIsearchPtr\fR)
  47. .sp
  48. char *
  49. \fBTcl_HashStats\fR(\fItablePtr\fR)
  50. .SH ARGUMENTS
  51. .AS Tcl_HashSearch *searchPtr
  52. .AP Tcl_HashTable *tablePtr in
  53. Address of hash table structure (for all procedures but
  54. \fBTcl_InitHashTable\fR, this must have been initialized by
  55. previous call to \fBTcl_InitHashTable\fR).
  56. .AP int keyType in
  57. Kind of keys to use for new hash table.  Must be either
  58. TCL_STRING_KEYS, TCL_ONE_WORD_KEYS, or an integer value
  59. greater than 1.
  60. .AP char *key in
  61. Key to use for probe into table.  Exact form depends on
  62. \fIkeyType\fR used to create table.
  63. .AP int *newPtr out
  64. The word at \fI*newPtr\fR is set to 1 if a new entry was created
  65. and 0 if there was already an entry for \fIkey\fR.
  66. .AP Tcl_HashEntry *entryPtr in
  67. Pointer to hash table entry.
  68. .AP ClientData value in
  69. New value to assign to hash table entry.  Need not have type
  70. ClientData, but must fit in same space as ClientData.
  71. .AP Tcl_HashSearch *searchPtr in
  72. Pointer to record to use to keep track of progress in enumerating
  73. all the entries in a hash table.
  74. .BE
  75.  
  76. .SH DESCRIPTION
  77. .PP
  78. A hash table consists of zero or more entries, each consisting of
  79. a key and a value.
  80. Given the key for an entry, the hashing routines can very quickly
  81. locate the entry, and hence its value.
  82. There may be at most one entry in a hash table with a
  83. particular key, but many entries may have the same value.
  84. Keys can take one of three forms:  strings,
  85. one-word values, or integer arrays.
  86. All of the keys in a given table have the same form, which is
  87. specified when the table is initialized.
  88. .PP
  89. The value of a hash table entry can be anything that fits in
  90. the same space as a ``char *'' pointer.
  91. Values for hash table entries are managed entirely by clients,
  92. not by the hash module itself.
  93. Typically each entry's value is a pointer to a data structure
  94. managed by client code.
  95. .PP
  96. Hash tables grow gracefully as the number of entries increases,
  97. so that there are always less than three entries per hash bucket,
  98. on average.
  99. This allows for fast lookups regardless of the number of entries
  100. in a table.
  101. .PP
  102. \fBTcl_InitHashTable\fR initializes a structure that describes
  103. a new hash table.
  104. The space for the structure is provided by the caller, not by
  105. the hash module.
  106. The value of \fIkeyType\fR indicates what kinds of keys will
  107. be used for all entries in the table.  \fIKeyType\fR must have
  108. one of the following values:
  109. .IP \fBTCL_STRING_KEYS\fR 25
  110. Keys are null-terminated ASCII strings.
  111. They are passed to hashing routines using the address of the
  112. first character of the string.
  113. .IP \fBTCL_ONE_WORD_KEYS\fR 25
  114. Keys are single-word values;  they are passed to hashing routines
  115. and stored in hash table entries as ``char *'' values.
  116. The pointer value is the key;  it need not (and usually doesn't)
  117. actually point to a string.
  118. .IP \fIother\fR 25
  119. If \fIkeyType\fR is not TCL_STRING_KEYS or TCL_ONE_WORD_KEYS,
  120. then it must be an integer value greater than 1.
  121. In this case the keys will be arrays of ``int'' values, where
  122. \fIkeyType\fR gives the number of ints in each key.
  123. This allows structures to be used as keys.
  124. All keys must have the same size.
  125. Array keys are passed into hashing functions using the address
  126. of the first int in the array.
  127. .PP
  128. \fBTcl_DeleteHashTable\fR deletes all of the entries in a hash
  129. table and frees up the memory associated with the table's
  130. bucket array and entries.
  131. It does not free the actual table structure (pointed to
  132. by \fItablePtr\fR), since that memory is assumed to be managed
  133. by the client.
  134. \fBTcl_DeleteHashTable\fR also does not free or otherwise
  135. manipulate the values of the hash table entries.
  136. If the entry values point to dynamically-allocated memory, then
  137. it is the client's responsibility to free these structures
  138. before deleting the table.
  139. .PP
  140. \fBTcl_CreateHashEntry\fR locates the entry corresponding to a
  141. particular key, creating a new entry in the table if there
  142. wasn't already one with the given key.
  143. If an entry already existed with the given key then \fI*newPtr\fR
  144. is set to zero.
  145. If a new entry was created, then \fI*newPtr\fR is set to a non-zero
  146. value and the value of the new entry will be set to zero.
  147. The return value from \fBTcl_CreateHashEntry\fR is a pointer to
  148. the entry, which may be used to retrieve and modify the entry's
  149. value or to delete the entry from the table.
  150. .PP
  151. \fBTcl_DeleteHashEntry\fR will remove an existing entry from a
  152. table.
  153. The memory associated with the entry itself will be freed, but
  154. the client is responsible for any cleanup associated with the
  155. entry's value, such as freeing a structure that it points to.
  156. .PP
  157. \fBTcl_FindHashEntry\fR is similar to \fBTcl_CreateHashEntry\fR
  158. except that it doesn't create a new entry if the key doesn't exist;
  159. instead, it returns NULL as result.
  160. .PP
  161. \fBTcl_GetHashValue\fR and \fBTcl_SetHashValue\fR are used to
  162. read and write an entry's value, respectively.
  163. Values are stored and retrieved as type ``ClientData'', which is
  164. large enough to hold a pointer value.  On almost all machines this is
  165. large enough to hold an integer value too.
  166. .PP
  167. \fBTcl_GetHashKey\fR returns the key for a given hash table entry,
  168. either as a pointer to a string, a one-word (``char *'') key, or
  169. as a pointer to the first word of an array of integers, depending
  170. on the \fIkeyType\fR used to create a hash table.
  171. In all cases \fBTcl_GetHashKey\fR returns a result with type
  172. ``char *''.
  173. When the key is a string or array, the result of \fBTcl_GetHashKey\fR
  174. points to information in the table entry;  this information will
  175. remain valid until the entry is deleted or its table is deleted.
  176. .PP
  177. \fBTcl_FirstHashEntry\fR and \fBTcl_NextHashEntry\fR may be used
  178. to scan all of the entries in a hash table.
  179. A structure of type ``Tcl_HashSearch'', provided by the client,
  180. is used to keep track of progress through the table.
  181. \fBTcl_FirstHashEntry\fR initializes the search record and
  182. returns the first entry in the table (or NULL if the table is
  183. empty).
  184. Each susequent call to \fBTcl_NextHashEntry\fR returns the
  185. next entry in the table or
  186. NULL if the end of the table has been reached.
  187. A call to \fBTcl_FirstHashEntry\fR followed by calls to
  188. \fBTcl_NextHashEntry\fR will return each of the entries in
  189. the table exactly once, in an arbitrary order.
  190. It is unadvisable to modify the structure of the table, e.g.
  191. by creating or deleting entries, while the search is in
  192. progress.
  193. .PP
  194. \fBTcl_HashStats\fR returns a dynamically-allocated string with
  195. overall information about a hash table, such as the number of
  196. entries it contains, the number of buckets in its hash array,
  197. and the utilization of the buckets.
  198. It is the caller's responsibility to free the result string
  199. by passing it to \fBfree\fR.
  200. .PP
  201. The header file \fBtclHash.h\fR defines the actual data structures
  202. used to implement hash tables.
  203. This is necessary so that clients can allocate Tcl_HashTable
  204. structures and so that macros can be used to read and write
  205. the values of entries.
  206. However, users of the hashing routines should never refer directly
  207. to any of the fields of any of the hash-related data structures;
  208. use the procedures and macros defined here.
  209.  
  210. .SH KEYWORDS
  211. hash table, key, lookup, search, value
  212.